# Package oracle.pgx.api

This package contains the Java APIs of PGX.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  PgxPath.PathIterable<E> |

- Class Summary
  Class | Description
  --- | ---
  AllPaths<ID extends Comparable<ID>> | The paths from one source vertex to all other vertices.
  Analyst | The Analyst gives access to all built-in algorithms of PGX.
  BipartiteGraph | A bipartite `PgxGraph`.
  Destroyable | Sub-classes of Destroyable can be explicitly destroyed
  EdgeCollection | A collection of edges.
  EdgeProperty<V extends Comparable<V>> | An edge property of a `PgxGraph`.
  EdgeSequence | An ordered sequence of edges which may contain duplicates.
  EdgeSet | An unordered set of edges (no duplicates).
  GraphMetaData | Meta information about `PgxGraph`.
  Partition<ID extends Comparable<ID>> | A vertex partition of a graph.
  Pgx | Main entry point for PGX applications.
  PgxCollection<E extends PgxEntity<ID>,ID extends Comparable<ID>> | A collection vertices/edges.
  PgxEdge | An edge of a `PgxGraph`.
  PgxEntity<ID extends Comparable<ID>> | An abstraction of vertex and edge.
  PgxFuture<T> | A PGX-specific extension of `CompletableFuture`
  PgxGraph | A PGX Graph
  PgxManagedObject | A PGX managed object.
  PgxMap<K extends Comparable<K>,V extends Comparable<V>> | A map is a collection of key-value pairs.
  PgxPath<ID extends Comparable<ID>> | A path from a source to a destination vertex in a `PgxGraph`.
  PgxPath.PathIterator<E> | A read-only `ListIterator` with an additional `PgxPath.PathIterator.reset()` method to start over iteration.
  PgxSession | A PGX session represents an active user connected to a `ServerInstance`.
  PgxVertex<ID extends Comparable<ID>> | A vertex of a `PgxGraph`.
  Property<ID extends Comparable<ID>,K extends PgxEntity<ID>,V extends Comparable<V>> | A property of a `PgxGraph`.
  Scalar<V> | A scalar value.
  ServerInstance | A PGX server instance.
  VertexCollection<ID extends Comparable<ID>> | A collection of vertices.
  VertexProperty<ID extends Comparable<ID>,V extends Comparable<V>> | A vertex property of a `PgxGraph`.
  VertexSequence<ID extends Comparable<ID>> | An ordered sequence of vertices which may contain duplicates.
  VertexSet<ID extends Comparable<ID>> | An unordered set of vertices (no duplicates).

- Enum Summary
  Enum | Description
  --- | ---
  MapType | The types of maps PGX supports.
  PgxGraph.Degree |
  PgxGraph.Direction |
  PgxGraph.Mode |
  PgxGraph.MultiEdges |
  PgxGraph.SelfEdges |
  PgxGraph.TrivialVertices |
  PoolType | An enum for the different thread-pools available within PGX.

## Package oracle.pgx.api Description

This package contains the Java APIs of PGX. You can access all Java APIs using the factory methods provided by `Pgx`.

- `oracle.pgx.api.internal.Core` PGX core functions
- `oracle.pgx.api.internal.algorithms.BuiltinAlgorithms` built-in algorithms
- `oracle.pgx.api.GraphAnalyst` quick access to built-in algorithms
- `Control` Administrative functions

Copyright © 2015. All rights reserved.